/* 
 * Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *      * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *      * The names of its contributors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package kameleon.util;

import java.io.File;

import kameleon.exception.FolderCreationException;

/**
 * Utility class for creating and maintaining the work space of this software.
 * 
 * @author		Schnell Michaël
 * @version		1.0
 */
public class WorkSpaceManager implements FileConstants {

	/**
	 * Sole constructor.
	 */
	protected WorkSpaceManager() {
		super() ;
	}// WorkSpaceManager()

	/**
	 * Checks if the folders needed to execute this software exists
	 * and creates them if not.
	 * 
	 * <p>The needed folders are:
	 * <pre>.kameleon
	 * |-  analyzer
	 * |-  config
	 * |-  generator
	 * |-  language
	 * |-  resources
	 * 
	 * @throws 	FolderCreationException
	 * 			if a needed folder could not be created
	 */
	public static void ensureWorkSpace() throws FolderCreationException {
		String[] folders = new String[]{
				PLUG_IN_WORK_FOLDER, 
				ANALYSER_FOLDER, 
				GENERATOR_FOLDER, 
				LANGUAGE_FOLDER, 
				CONFIG_FOLDER, 
				PLUG_IN_RESOURCES_FOLDER
		} ;
		// Create folders if they do not exist
		for(String folderPath : folders) {
			File folder = new File(folderPath) ;
			boolean exists = folder.exists() || folder.mkdir() ;
			if (!exists || !folder.isDirectory()) {
				throw new FolderCreationException(folder) ;
			}// if
		}// for
	}// ensureWorkSpace()

}// class WorkSpaceManager